{ "openapi": "3.0.1", "info": { "title": "UK Company Growth Signals: Companies House + LinkedIn", "description": "Rank UK companies by Companies House filings and optional LinkedIn headcount changes. Get a 0-100 score, dated evidence and research angles. Free demo; bring a Companies House API key for live records.", "version": "0.1", "x-build-id": "5IdiQ5MLpbWDcqvyL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fractionalhqforyou~uk-company-growth-signals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fractionalhqforyou-uk-company-growth-signals", "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/fractionalhqforyou~uk-company-growth-signals/runs": { "post": { "operationId": "runs-sync-fractionalhqforyou-uk-company-growth-signals", "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/fractionalhqforyou~uk-company-growth-signals/run-sync": { "post": { "operationId": "run-sync-fractionalhqforyou-uk-company-growth-signals", "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": { "companies": { "title": "Company names or numbers", "type": "string", "description": "Enter one item per line. A company number (for example 09876543 or SC123456) is looked up directly. A name is searched and only accepted when the top hit is the same name; otherwise you get the top 3 candidates and matched:false. Add a linkedin.com/company URL after the name or number, separated by a space, to skip the LinkedIn name search. Leave empty to use the search below instead." }, "searchQuery": { "title": "Search: keyword in company name", "type": "string", "description": "Used when the list above is empty. Every company whose name contains this text, up to the maximum below. Combine with a SIC code and postcode prefix to narrow it." }, "sicCode": { "title": "Search: SIC code", "type": "string", "description": "A 5-digit UK SIC 2007 code, for example 62012 for business and domestic software development. This is optional. Filters the search." }, "postcodePrefix": { "title": "Search: registered address postcode prefix", "type": "string", "description": "For example M1, EC2 or BS1. This is optional. Filters the search by registered office location." }, "maxResults": { "title": "Search: maximum results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap on companies returned by a search. Each company checked is one charged event.", "default": 20 }, "apiKey": { "title": "Companies House API key", "type": "string", "description": "The key is free. Register at https://developer.company-information.service.gov.uk/ and create a REST API key. Apify stores it as a secret. Without it the Actor runs in demo mode: 3 sample rows, nothing charged." }, "includeDissolved": { "title": "Include dissolved companies in a search", "type": "boolean", "description": "Searches return active companies only by default. Switch on to include dissolved and liquidated ones.", "default": false }, "linkedinLookup": { "title": "Look up LinkedIn headcount and followers", "type": "boolean", "description": "Runs harvestapi/linkedin-company for each matched company and reads employee count and follower count. That run is billed to your own Apify account on top of this Actor's price. When it cannot run, the row still scores from the register with linkedin_status set to unavailable.", "default": true }, "watchKey": { "title": "Watch key", "type": "string", "description": "Names the saved headcount snapshot this run compares against. Use the same key every month for the same list and you get the headcount change since last time. Use a different key and you start a fresh baseline.", "default": "default" }, "lookbackMonths": { "title": "Lookback window in months", "minimum": 1, "maximum": 24, "type": "integer", "description": "How far back to count board appointments, resignations, share allotments, office moves and name changes.", "default": 6 } } }, "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 } } }, "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 } } } } } } } } } }