{ "openapi": "3.0.1", "info": { "title": "UK Companies House: Company Data, SIC Search & Change Monitor", "description": "UK company data for all 5.7M live companies from Companies House's free monthly Basic Company Data. Look up by number or name, search by SIC code, postcode and status, or get a monthly change feed. No director or PSC personal data.", "version": "0.1", "x-build-id": "DWcXUzdMhkJyGz38Z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yourevenings~uk-companies-house/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yourevenings-uk-companies-house", "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/yourevenings~uk-companies-house/runs": { "post": { "operationId": "runs-sync-yourevenings-uk-companies-house", "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/yourevenings~uk-companies-house/run-sync": { "post": { "operationId": "run-sync-yourevenings-uk-companies-house", "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": { "mode": { "title": "Mode", "enum": [ "auto", "lookup", "search", "changes", "monitor" ], "type": "string", "description": "Auto picks lookup when you give company numbers, names or a dataset ID; changes when you pick change types; otherwise search.", "default": "auto" }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "8-character Companies House numbers. Short numbers are zero-padded (445790 = 00445790); SC, NI, OC and other prefixes are accepted. In changes mode this is a watchlist.", "items": { "type": "string" } }, "companyNames": { "title": "Company names", "type": "array", "description": "Matched against current registered names: exact, or normalised (case, punctuation, & / and, Limited / Ltd, PLC forms). Each row shows matchConfidence. No match gives a free not_found row with up to 3 similar names. Up to 1,000 names.", "items": { "type": "string" } }, "tenderDatasetId": { "title": "Dataset ID with company numbers (advanced)", "type": "string", "description": "ID of a dataset from your own Apify account whose items list company numbers in awards[].supplierCompanyNumber. Each number is looked up as if you had entered it under Company numbers, and the matching dataset details are added to that company's row." }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "2 to 5 digits; prefix match (62 = all IT, 62012 = software development).", "items": { "type": "string" } }, "companyStatus": { "title": "Company status", "type": "array", "description": "active, proposal to strike off, liquidation, administration, receivership, voluntary arrangement, or an exact status as published.", "items": { "type": "string" } }, "companyTypes": { "title": "Company types", "type": "array", "description": "Phrase match on the published category, e.g. \"Private Limited Company\", \"Limited Liability Partnership\", \"Community Interest Company\".", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated from", "type": "string", "description": "YYYY-MM-DD." }, "incorporatedTo": { "title": "Incorporated to", "type": "string", "description": "YYYY-MM-DD." }, "incorporatedWithinDays": { "title": "Incorporated within the last N days", "minimum": 1, "type": "integer", "description": "Counted back from today. The newest companies in the data are from the end of the month before the snapshot date." }, "postTowns": { "title": "Post towns", "type": "array", "description": "Registered office post town, e.g. MANCHESTER.", "items": { "type": "string" } }, "postcodes": { "title": "Postcodes", "type": "array", "description": "Area (EC, M), district (EC1V, M1) or a full or partial postcode (M1 1AE).", "items": { "type": "string" } }, "nameKeywords": { "title": "Name keywords", "type": "array", "description": "Whole words or phrases in the company name.", "items": { "type": "string" } }, "accountsOverdue": { "title": "Accounts overdue only", "type": "boolean", "description": "Next accounts due date before the snapshot date.", "default": false }, "confirmationStatementOverdue": { "title": "Confirmation statement overdue only", "type": "boolean", "description": "Next confirmation statement due date before the snapshot date.", "default": false }, "hasOutstandingCharges": { "title": "Has outstanding charges only", "type": "boolean", "description": "Only companies with at least one outstanding charge (mortgage or other security) registered.", "default": false }, "changeTypes": { "title": "Change types", "type": "array", "description": "Changes mode: which month-over-month changes to return. Leave empty for all (in monitor mode all are always returned).", "items": { "type": "string", "enum": [ "new_on_register", "removed_from_register", "status_changed", "name_changed", "sic_changed", "type_changed", "registered_office_moved", "accounts_now_overdue", "accounts_filed", "confirmation_statement_now_overdue", "confirmation_statement_filed", "new_charge", "charges_changed" ], "enumTitles": [ "New on the register (incorporated or first seen)", "Left the live register (dissolved or closed)", "Status changed (e.g. liquidation, proposal to strike off)", "Name changed", "SIC codes changed", "Company type changed", "Registered office moved (post town or postcode)", "Accounts now overdue", "New accounts filed", "Confirmation statement now overdue", "New confirmation statement filed", "New charge registered", "Charge counts changed (e.g. satisfied)" ] } }, "monitorMode": { "title": "Monitor mode", "type": "boolean", "description": "Compare your company numbers with your last run. The first run saves a free baseline; later runs return one change row per change once a newer monthly snapshot is out. Schedule it monthly.", "default": false }, "stateStoreName": { "title": "Monitor state store", "type": "string", "description": "Named key-value store in your account that holds the monitor baseline. Use a different name per watchlist.", "default": "uk-companies-house-monitor" }, "dataMonth": { "title": "Snapshot month", "type": "string", "description": "YYYY-MM-01 to use an older snapshot (the last 3 months are kept). Leave empty for the newest." }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Maximum charged rows. 0 = no limit. Status rows are free and don't count.", "default": 25 }, "countAllMatches": { "title": "Count all matches", "type": "boolean", "description": "Keep reading after maxResults so the run summary has the full match count (no extra charge).", "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 } } } } } } } } } }