{ "openapi": "3.0.1", "info": { "title": "Companies House Deadlines: Overdue Accounts & Filings Due", "description": "UK companies with overdue or upcoming Companies House deadlines: accounts and confirmation statements, each checked live, with due dates, days overdue, address, SIC codes and directors. Filter by postcode, town, industry and company type. For accountants, lenders and B2B sales.", "version": "0.1", "x-build-id": "d34Z0Ppyx6amZT6YH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pikoulas~companies-house-deadlines/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pikoulas-companies-house-deadlines", "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/pikoulas~companies-house-deadlines/runs": { "post": { "operationId": "runs-sync-pikoulas-companies-house-deadlines", "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/pikoulas~companies-house-deadlines/run-sync": { "post": { "operationId": "run-sync-pikoulas-companies-house-deadlines", "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": { "filings": { "title": "Filings", "type": "array", "description": "The deadlines to look at: annual accounts, confirmation statements, or both (a company matches on either).", "items": { "type": "string", "enum": [ "accounts", "confirmation-statement" ], "enumTitles": [ "Accounts", "Confirmation statement" ] }, "default": [ "accounts", "confirmation-statement" ] }, "deadline": { "title": "Deadline", "type": "array", "description": "Filings already overdue, filings due in the next days, or both.", "items": { "type": "string", "enum": [ "overdue", "due-soon" ], "enumTitles": [ "Overdue", "Due soon" ] }, "default": [ "overdue" ] }, "dueWithinDays": { "title": "Due within (days)", "minimum": 0, "maximum": 400, "type": "integer", "description": "For due soon: filings due in the next this many days.", "default": 30 }, "minDaysOverdue": { "title": "At least days overdue", "minimum": 0, "type": "integer", "description": "For overdue: only filings at least this many days late." }, "maxDaysOverdue": { "title": "At most days overdue", "minimum": 0, "type": "integer", "description": "For overdue: only filings at most this many days late (30 for companies that just missed theirs)." }, "postcodes": { "title": "Postcodes", "type": "array", "description": "Registered office postcodes, one a line: an area (M, SW), a district (M1, SW1A, EC2) or a full postcode. Empty for all of the UK.", "items": { "type": "string" } }, "towns": { "title": "Post towns", "type": "array", "description": "Registered office post towns, one a line (London, Manchester, Leeds). Empty for all.", "items": { "type": "string" } }, "sicCodes": { "title": "SIC codes", "type": "array", "description": "Industries by SIC code or its start, one a line: 62 for IT, 56101 for restaurants, 41 for building. Empty for all.", "items": { "type": "string" } }, "companyTypes": { "title": "Company types", "type": "array", "description": "Empty for all.", "items": { "type": "string", "enum": [ "private-limited", "guarantee", "plc", "llp", "limited-partnership", "cic", "charity", "overseas-entity", "other" ], "enumTitles": [ "Private limited (Ltd)", "Limited by guarantee", "Public limited (PLC)", "LLP", "Limited partnership", "Community interest company", "Charitable incorporated organisation", "Overseas entity", "Other" ] } }, "accountsTypes": { "title": "Accounts types", "type": "array", "description": "The kind of accounts the company last filed, which says its size. Empty for all.", "items": { "type": "string", "enum": [ "micro-entity", "total-exemption", "abridged", "small", "medium", "full", "group", "dormant", "subsidiary", "none-filed", "other" ], "enumTitles": [ "Micro-entity", "Total exemption", "Abridged", "Small", "Medium", "Full", "Group", "Dormant", "Subsidiary exemption", "None filed yet (new companies)", "Other" ] } }, "incorporatedAfter": { "title": "Incorporated from", "type": "string", "description": "Only companies incorporated on or after this date, YYYY-MM-DD." }, "incorporatedBefore": { "title": "Incorporated to", "type": "string", "description": "Only companies incorporated on or before this date." }, "includeStrikeOff": { "title": "Include proposals to strike off", "type": "boolean", "description": "Companies Companies House has given notice of striking off, often for the very filings overdue.", "default": true }, "checkCurrent": { "title": "Check each company live", "type": "boolean", "description": "Read each company's Companies House page for its deadlines as of today; the monthly file is up to a month old and most overdue companies file within weeks. Off is faster, with the file's deadlines.", "default": true }, "includeDirectors": { "title": "Include directors", "type": "boolean", "description": "The current directors and secretaries of each company, with their role, appointment date and correspondence address.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The run stops after this many companies.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed: Companies House answers without one. Datacenter IPs cost nothing extra; residential ones are charged per 100 KB fetched (the company data file is always downloaded without a proxy).", "default": { "useApifyProxy": 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 } } } } } } } } } }