{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Companies House New Company Leads",
    "description": "Newly incorporated UK companies from the official Companies House register. Filter by date, SIC code or keyword, location, postcode and company type. Get directors, SIC descriptions and addresses, with daily new-only monitoring.",
    "version": "1.0",
    "x-build-id": "vJWc06aiuI4dWrf2p"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/zrk1212~uk-new-company-leads/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-zrk1212-uk-new-company-leads",
        "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/zrk1212~uk-new-company-leads/runs": {
      "post": {
        "operationId": "runs-sync-zrk1212-uk-new-company-leads",
        "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/zrk1212~uk-new-company-leads/run-sync": {
      "post": {
        "operationId": "run-sync-zrk1212-uk-new-company-leads",
        "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": "Days back",
            "minimum": 1,
            "maximum": 365,
            "type": "integer",
            "description": "Find companies incorporated in the last N days (today included). Ignored if Incorporated from is set.",
            "default": 7
          },
          "incorporatedFrom": {
            "title": "Incorporated from",
            "type": "string",
            "description": "Start of the incorporation date range (YYYY-MM-DD). Overrides Days back."
          },
          "incorporatedTo": {
            "title": "Incorporated to",
            "type": "string",
            "description": "End of the incorporation date range (YYYY-MM-DD). Leave empty for today."
          },
          "sicCodes": {
            "title": "SIC codes",
            "type": "array",
            "description": "SIC 2007 codes, for example 62012 (software development) or 56101 (restaurants). Leave empty for all industries (unless you use Industry keywords).",
            "items": {
              "type": "string"
            }
          },
          "sicKeywords": {
            "title": "Industry keywords",
            "type": "array",
            "description": "Industry words matched against the official SIC descriptions, for example software, bakery, dental. Matching codes are added to SIC codes, and the log lists the codes used.",
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Town, city or area passed to the Companies House location filter, for example Manchester."
          },
          "postcodePrefixes": {
            "title": "Postcode prefixes",
            "type": "array",
            "description": "Keep only companies whose registered office postcode starts with one of these, for example M1, EC1A or LS. Letters only (LS) means the whole postcode area. Case and spaces are ignored.",
            "items": {
              "type": "string"
            }
          },
          "companyTypes": {
            "title": "Company types",
            "type": "array",
            "description": "Company types to include. Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "ltd",
                "llp",
                "plc",
                "private-limited-guarant-nsc",
                "private-limited-guarant-nsc-limited-exemption",
                "private-unlimited",
                "limited-partnership",
                "scottish-partnership",
                "registered-society-non-jurisdictional",
                "uk-establishment",
                "registered-overseas-entity"
              ],
              "enumTitles": [
                "Private limited company",
                "Limited liability partnership",
                "Public limited company",
                "Private limited by guarantee without share capital",
                "Private Limited Company by guarantee without share capital, use of 'Limited' exemption",
                "Private unlimited company",
                "Limited partnership",
                "Scottish qualifying partnership",
                "Registered society",
                "UK establishment company",
                "Overseas entity"
              ]
            },
            "default": [
              "ltd"
            ]
          },
          "companyStatus": {
            "title": "Company status",
            "type": "array",
            "description": "Company status. New companies are almost always active.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "dissolved",
                "liquidation",
                "administration",
                "voluntary-arrangement",
                "receivership",
                "insolvency-proceedings"
              ],
              "enumTitles": [
                "Active",
                "Dissolved",
                "Liquidation",
                "Administration",
                "Voluntary arrangement",
                "Receivership",
                "Insolvency proceedings"
              ]
            },
            "default": [
              "active"
            ]
          },
          "excludeDormant": {
            "title": "Exclude dormant and non-trading companies",
            "type": "boolean",
            "description": "Drop companies whose only SIC codes are 99999 (Dormant Company) or 74990 (Non-trading company). These are usually shells, not leads.",
            "default": true
          },
          "nameIncludes": {
            "title": "Name includes",
            "type": "string",
            "description": "Only companies whose name contains this text."
          },
          "nameExcludes": {
            "title": "Name excludes",
            "type": "string",
            "description": "Drop companies whose name contains this text."
          },
          "includeOfficers": {
            "title": "Include directors and officers",
            "type": "boolean",
            "description": "Add current officers: name, first and last name, role, appointment date, occupation. One extra API call per company.",
            "default": true
          },
          "includeOfficerServiceAddress": {
            "title": "Include officer service addresses",
            "type": "boolean",
            "description": "Also output each officer's correspondence (service) address as published on the register. Off by default because small company directors often use their home as the service address.",
            "default": false
          },
          "includePsc": {
            "title": "Include persons with significant control",
            "type": "boolean",
            "description": "Add persons with significant control: name, kind, nature of control, notified date. One extra API call per company.",
            "default": false
          },
          "maxResults": {
            "title": "Max companies",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Maximum companies to output, newest first. The UK registers 2,000 to 3,500 companies per working day, so raise this for an all-industry feed.",
            "default": 500
          },
          "monitorMode": {
            "title": "Monitor mode (only new since last run)",
            "type": "boolean",
            "description": "Only output companies not returned by earlier runs with the same Monitor ID. Use it with a daily Apify Schedule. The first run outputs everything in range.",
            "default": false
          },
          "monitorId": {
            "title": "Monitor ID",
            "type": "string",
            "description": "Name for this monitor, for example leeds-accountants. If empty in monitor mode, one is derived from the filters."
          },
          "companiesHouseApiKey": {
            "title": "Your Companies House API key (optional)",
            "type": "string",
            "description": "Optional. Your own free Companies House API key gives you your own rate limit (600 requests per 5 minutes), so large runs are faster and never wait for other users."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}