{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Company Lead Lists – SIC, Postcode, New Companies",
    "description": "Build verified UK company lead lists: filter 5.7M live companies by SIC code, postcode, town, incorporation date, status, type and accounts size. Optional website, e-mail and phone finder. No API key.",
    "version": "0.1",
    "x-build-id": "wsY0uymDxi8bvy8l5"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/stimulating_stilbite~uk-companies-house-lead-lists/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-stimulating_stilbite-uk-companies-house-lead-lists",
        "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/stimulating_stilbite~uk-companies-house-lead-lists/runs": {
      "post": {
        "operationId": "runs-sync-stimulating_stilbite-uk-companies-house-lead-lists",
        "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/stimulating_stilbite~uk-companies-house-lead-lists/run-sync": {
      "post": {
        "operationId": "run-sync-stimulating_stilbite-uk-companies-house-lead-lists",
        "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": {
          "sicCodes": {
            "title": "SIC codes",
            "type": "array",
            "description": "SIC 2007 codes (62012), prefixes (62, 620) or section letters (J = information & communication, F = construction, M = professional services, I = hospitality, Q = health). Any of them.",
            "items": {
              "type": "string"
            }
          },
          "postcodePrefixes": {
            "title": "Postcode area / prefix",
            "type": "array",
            "description": "Registered-office postcode. Letters only = exact postcode area (M = Manchester, not ME/ML; B = Birmingham; EH = Edinburgh). With digits = prefix (EC1, SW1A, M1).",
            "items": {
              "type": "string"
            }
          },
          "postTowns": {
            "title": "Post towns",
            "type": "array",
            "description": "Registered-office post town contains, e.g. LEEDS, BRISTOL.",
            "items": {
              "type": "string"
            }
          },
          "incorporatedFrom": {
            "title": "Incorporated from",
            "type": "string",
            "description": "YYYY-MM-DD. Use a recent date for new-company leads."
          },
          "incorporatedTo": {
            "title": "Incorporated to",
            "type": "string",
            "description": "YYYY-MM-DD."
          },
          "statuses": {
            "title": "Company status",
            "type": "array",
            "description": "Default: Active only.",
            "items": {
              "type": "string",
              "enum": [
                "Active",
                "Active - Proposal to Strike off",
                "Liquidation",
                "In Administration",
                "Voluntary Arrangement",
                "Live but Receiver Manager on at least one charge"
              ]
            },
            "default": [
              "Active"
            ]
          },
          "companyTypes": {
            "title": "Company types (contains)",
            "type": "array",
            "description": "e.g. \"Private Limited Company\", \"Public Limited Company\", \"Limited Liability Partnership\", \"Community Interest Company\".",
            "items": {
              "type": "string"
            }
          },
          "accountCategories": {
            "title": "Accounts category",
            "type": "array",
            "description": "Size proxy from the last filed accounts. MICRO ENTITY, TOTAL EXEMPTION FULL, UNAUDITED ABRIDGED, SMALL, MEDIUM, FULL, GROUP, DORMANT, NO ACCOUNTS FILED.",
            "items": {
              "type": "string",
              "enum": [
                "MICRO ENTITY",
                "TOTAL EXEMPTION FULL",
                "TOTAL EXEMPTION SMALL",
                "UNAUDITED ABRIDGED",
                "SMALL",
                "MEDIUM",
                "FULL",
                "GROUP",
                "AUDIT EXEMPTION SUBSIDIARY",
                "NO ACCOUNTS FILED",
                "DORMANT"
              ]
            }
          },
          "excludeDormant": {
            "title": "Exclude dormant companies",
            "type": "boolean",
            "description": "Skip companies with dormant accounts or SIC 99999.",
            "default": true
          },
          "nameKeywords": {
            "title": "Name contains",
            "type": "array",
            "description": "e.g. \"DIGITAL\", \"CONSULTING\".",
            "items": {
              "type": "string"
            }
          },
          "companyNumbers": {
            "title": "Company numbers",
            "type": "array",
            "description": "Optional: look up specific company numbers (8 characters, e.g. 03998084). Combine with SIC/postcode to read less data.",
            "items": {
              "type": "string"
            }
          },
          "sortBy": {
            "title": "Sort",
            "enum": [
              "newest",
              "oldest"
            ],
            "type": "string",
            "description": "newest = most recently incorporated first.",
            "default": "newest"
          },
          "maxItems": {
            "title": "Max companies",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Up to 50,000 per run.",
            "default": 100
          },
          "findWebsite": {
            "title": "Find website",
            "type": "boolean",
            "description": "Guess and verify the company's website (must show the company number or name + town). Slower.",
            "default": false
          },
          "scrapeContacts": {
            "title": "Find e-mail & phone on the website",
            "type": "boolean",
            "description": "Reads the homepage + up to 3 contact/about pages (robots.txt respected). Role mailboxes only (info@, sales@…) unless you allow personal e-mails.",
            "default": false
          },
          "includePersonalEmails": {
            "title": "Include personal-looking e-mails",
            "type": "boolean",
            "description": "firstname.lastname@ addresses. Mind UK GDPR / PECR.",
            "default": false
          },
          "maxPagesPerSite": {
            "title": "Max pages per website",
            "minimum": 1,
            "maximum": 8,
            "type": "integer",
            "description": "1–8.",
            "default": 3
          },
          "buildIndex": {
            "title": "Rebuild index (owner only)",
            "type": "boolean",
            "description": "Internal maintenance option; ignored for other users.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}