{ "openapi": "3.0.1", "info": { "title": "UK Company Incorporation Alerts by SIC Code", "description": "Get every UK company newly incorporated for a SIC code, postcode area, or name filter, as a sales lead-gen and compliance alert, not a one-company lookup. Keyless by default (public register); an optional free Companies House API key routes to the authenticated advanced-search API instead.", "version": "1.0", "x-build-id": "TirrjuxeO4bnQu1kQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~uk-company-incorporation-alert/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-uk-company-incorporation-alert", "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/accountable_eel~uk-company-incorporation-alert/runs": { "post": { "operationId": "runs-sync-accountable_eel-uk-company-incorporation-alert", "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/accountable_eel~uk-company-incorporation-alert/run-sync": { "post": { "operationId": "run-sync-accountable_eel-uk-company-incorporation-alert", "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 to watch (e.g. 62012)", "type": "array", "description": "One SIC code per line, OR'd together. Combine with the filters below (postcode prefixes, company name, type, date window) — all optional but at least one of them, or a company-type/postcode/name filter, is required. Leave empty to filter by postcode prefix or company name alone. Accepted formats: 62012, 62020, 41100. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from (date)", "type": "string", "description": "Defaults to 7 days before today if left empty.", "default": "" }, "incorporatedTo": { "title": "Incorporated to (date)", "type": "string", "description": "Defaults to today if left empty.", "default": "" }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Max companies per run", "type": "integer", "description": "Up to 2,000. Caps how many companies you get (and pay for) in one run.", "default": 100 }, "companyTypes": { "title": "Company type", "enum": [ "all", "ltd", "llp", "plc" ], "type": "string", "description": "Restrict to one company type, or leave as \"All types\".", "default": "all" }, "postcodePrefixes": { "title": "Postcode prefixes", "type": "array", "description": "Optional. e.g. \"EC1\", \"M\" — matched as OR against the registered office postcode's prefix. Applied after fetching (Companies House has no server-side postcode-prefix filter), so it never reduces the cost of the underlying search, only what you're billed and shown.", "items": { "type": "string" } }, "companyNameIncludes": { "title": "Company name includes", "type": "string", "description": "Optional. Matches company names containing this text.", "default": "" }, "apiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Optional. Your own free Companies House API key (https://developer.company-information.service.gov.uk/) routes this run through the authenticated advanced-search API instead of the public register website. Leave empty to use the free public register, which returns the same incorporation date, type, status, address, and SIC codes." }, "onlyNewSinceLastRun": { "title": "Only return companies new since the last run (monitoring)", "type": "boolean", "description": "On: only new company numbers since your last run are returned and charged for — run this on a schedule as an incorporation alert. Off: every matching company is returned every time.", "default": false }, "deltaName": { "title": "Watchlist name (optional)", "type": "string", "description": "Optional. Name this search's monitoring memory so you can tell two schedules of this actor apart, or keep one memory across an input change. Leave empty to auto-derive one from your filters.", "default": "" }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "searchSummary", "companyCount", "truncated", "monitorStatus", "companies", "companyNumber", "companyName", "incorporatedOn", "companyType", "companyStatus", "sicCodes", "sicDescriptions", "registeredAddress", "postcode", "locality", "companyUrl", "route", "isNew", "firstSeenAt" ], "enumTitles": [ "Search run", "Companies returned", "More results were available", "Monitoring status", "All companies (full list)", "Company number", "Company name", "Incorporated on", "Company type", "Status", "SIC codes", "SIC descriptions", "Registered office address", "Postcode", "Locality / town", "Companies House page", "Source route", "Is this company new?", "First seen on a run" ] }, "default": [ "searchSummary", "companyCount", "truncated", "monitorStatus", "companies", "companyNumber", "companyName", "incorporatedOn", "companyType", "companyStatus", "sicCodes", "sicDescriptions", "registeredAddress", "postcode", "locality", "companyUrl", "route", "isNew", "firstSeenAt" ] }, "expandRows": { "title": "One row per company (recommended) — turn off for one row per search instead", "type": "boolean", "description": "When on, each company found gets its own row instead of being grouped under its search. You're still only charged once per search, no matter how many rows it produces.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy config. Residential recommended for anti-bot-sensitive targets.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }