{ "openapi": "3.0.1", "info": { "title": "UK Companies House Accounts: Company Financials", "description": "UK company financial statements from Companies House accounts (iXBRL): equity, net assets, total assets, cash, current assets, employees, and turnover and profit when filed. Reads the official daily bulk files, no API key. One JSON row per set of accounts, with the prior year.", "version": "0.1", "x-build-id": "LH8iSjcH1leL66woy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nordicdata~uk-annual-accounts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nordicdata-uk-annual-accounts", "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/nordicdata~uk-annual-accounts/runs": { "post": { "operationId": "runs-sync-nordicdata-uk-annual-accounts", "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/nordicdata~uk-annual-accounts/run-sync": { "post": { "operationId": "run-sync-nordicdata-uk-annual-accounts", "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": [ "latestFilings", "companyLookup" ], "type": "string", "description": "latestFilings reads the Companies House daily bulk files, which hold every set of accounts filed electronically on that day. companyLookup reads the newest accounts of the companies you list.", "default": "latestFilings" }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "UK company numbers, for example 00445790 or SC123456. Required for companyLookup. In latestFilings mode the list keeps only these companies.", "items": { "type": "string" } }, "daysBack": { "title": "Daily files to read", "minimum": 1, "maximum": 60, "type": "integer", "description": "latestFilings: how many of the newest daily files to read. Each holds about 7,000 to 15,000 accounts. Companies House keeps the last 60.", "default": 1 }, "dateFrom": { "title": "Daily files from", "type": "string", "description": "Optional. First daily file date, YYYY-MM-DD. Overrides daysBack." }, "dateTo": { "title": "Daily files to", "type": "string", "description": "Optional. Last daily file date, YYYY-MM-DD." }, "accountsTypes": { "title": "Accounts types", "type": "array", "description": "Keep only these accounts types. Leave empty for all.", "items": { "type": "string", "enum": [ "full accounts", "abridged accounts", "filleted accounts", "micro-entity accounts" ], "enumTitles": [ "Full", "Abridged", "Filleted", "Micro-entity" ] } }, "excludeDormant": { "title": "Skip dormant companies", "type": "boolean", "description": "Skip accounts that the company marks as dormant.", "default": true }, "requireTurnover": { "title": "Only accounts with turnover", "type": "boolean", "description": "Keep only accounts that publish turnover. Most small companies file a balance sheet only, so this keeps about 1 in 100.", "default": false }, "minEquity": { "title": "Min equity (GBP)", "type": "integer", "description": "Keep accounts with at least this equity (or net assets)." }, "minTotalAssets": { "title": "Min total assets (GBP)", "type": "integer", "description": "Keep accounts with at least this total assets." }, "minEmployees": { "title": "Min average employees", "type": "integer", "description": "Keep accounts with at least this average number of employees." }, "accountsPerCompany": { "title": "Accounts per company", "minimum": 1, "maximum": 10, "type": "integer", "description": "companyLookup: how many of the newest electronic accounts to read per company.", "default": 1 }, "maxItems": { "title": "Max rows", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Stop after this many rows.", "default": 1000 }, "requestIntervalSeconds": { "title": "Seconds between requests", "minimum": 0.5, "type": "number", "description": "Pause between requests to Companies House. At least 0.5.", "default": 1 } } }, "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 } } } } } } } } } }