{
  "openapi": "3.0.1",
  "info": {
    "title": "UK New Companies - Companies House New Incorporations Feed",
    "description": "New UK companies from the official Companies House register, by day: company number, name, type, SIC industry codes and descriptions, registered address and postcode, and optionally directors' names. Filter by industry, postcode area or name, and get only new companies on a daily schedule.",
    "version": "1.0",
    "x-build-id": "e6AL2MBIq1yOYrRQC"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sonic_scraper~uk-new-companies/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sonic_scraper-uk-new-companies",
        "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/sonic_scraper~uk-new-companies/runs": {
      "post": {
        "operationId": "runs-sync-sonic_scraper-uk-new-companies",
        "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/sonic_scraper~uk-new-companies/run-sync": {
      "post": {
        "operationId": "run-sync-sonic_scraper-uk-new-companies",
        "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": {
          "incorporatedWithinDays": {
            "title": "Incorporated in the last (days)",
            "minimum": 1,
            "maximum": 90,
            "type": "integer",
            "description": "Companies incorporated today and the days before, up to 90. Use 1-3 for a daily feed. Ignored when a date range is set below.",
            "default": 3
          },
          "dateFrom": {
            "title": "From date",
            "type": "string",
            "description": "Optional fixed range start (YYYY-MM-DD). At most 90 days per run."
          },
          "dateTo": {
            "title": "To date",
            "type": "string",
            "description": "Optional fixed range end (YYYY-MM-DD)."
          },
          "sicCodes": {
            "title": "SIC codes",
            "type": "array",
            "description": "Keep companies with any of these SIC 2007 codes. Prefixes work: \"43\" = all specialised construction, \"620\" = software and IT, \"56101\" = restaurants.",
            "items": {
              "type": "string"
            }
          },
          "industrySections": {
            "title": "Industry sections",
            "type": "array",
            "description": "SIC sections A-U of the main activity, for example F (construction), I (hospitality), J (information and communication), M (professional services), Q (health).",
            "items": {
              "type": "string"
            }
          },
          "postcodePrefixes": {
            "title": "Postcode areas or districts",
            "type": "array",
            "description": "Registered-office postcode prefixes, for example \"M\" (Manchester), \"EC1\", \"B1\", \"G\" (Glasgow), \"BT\" (Northern Ireland).",
            "items": {
              "type": "string"
            }
          },
          "addressContains": {
            "title": "Address contains",
            "type": "array",
            "description": "Keep companies whose registered address contains any of these words, for example a town: \"Bristol\".",
            "items": {
              "type": "string"
            }
          },
          "nameIncludes": {
            "title": "Name contains",
            "type": "array",
            "description": "Keep companies whose name contains any of these words, for example \"dental\" or \"property\".",
            "items": {
              "type": "string"
            }
          },
          "nameExcludes": {
            "title": "Name excludes",
            "type": "array",
            "description": "Skip companies whose name contains any of these words, for example \"holdings\".",
            "items": {
              "type": "string"
            }
          },
          "companyTypes": {
            "title": "Company types",
            "type": "array",
            "description": "Companies House type codes, for example ltd, llp, plc, private-limited-guarant-nsc (charities and clubs), limited-partnership. Empty = all.",
            "items": {
              "type": "string"
            }
          },
          "activeOnly": {
            "title": "Active companies only",
            "type": "boolean",
            "description": "Skip companies already dissolved or in another non-active status.",
            "default": true
          },
          "excludeDormant": {
            "title": "Skip dormant companies",
            "type": "boolean",
            "description": "Skip companies registered as dormant (SIC 99999), which usually do not trade.",
            "default": true
          },
          "includeOfficers": {
            "title": "Add directors",
            "type": "boolean",
            "description": "Add each company's active officers (name, role, appointment date) from its public Companies House page. One extra page per company, so runs are slower (about 2 companies per second). Dates of birth, nationalities and home addresses are not collected.",
            "default": false
          },
          "maxResults": {
            "title": "Maximum companies to save",
            "minimum": 0,
            "maximum": 200000,
            "type": "integer",
            "description": "Stop after this many companies (each is billed). 0 = no limit. About 2,000-3,500 UK companies are incorporated on a weekday.",
            "default": 500
          },
          "onlyNew": {
            "title": "Only new companies (monitoring)",
            "type": "boolean",
            "description": "Skip companies this monitor already saved in earlier runs. Schedule daily with \"last 3 days\" so late-registered companies are not missed and none are billed twice.",
            "default": false
          },
          "stateKey": {
            "title": "Monitor name",
            "type": "string",
            "description": "Use a different name for each separate lead list.",
            "default": "default"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}