{ "openapi": "3.0.1", "info": { "title": "UK Company Data API - Financials, Credit Scores, Officers", "description": "Search United Kingdom registered companies and pull filed financials, credit checks, officers, shareholders, people with significant control, group structure and filing history. Registry-sourced data, pay per result, bring your own API key.", "version": "0.1", "x-build-id": "qvatv2gJGVQfdyYfu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~uk-company-financials-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-uk-company-financials-api", "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/nabeelbaghoor~uk-company-financials-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-uk-company-financials-api", "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/nabeelbaghoor~uk-company-financials-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-uk-company-financials-api", "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": { "query": { "title": "Search term", "type": "string", "description": "Free-text company search, by name or by registration number. Leave empty when you are supplying a list of company numbers instead." }, "companyNumbers": { "title": "Company numbers", "type": "array", "description": "Registration numbers to look up directly. A bare numeric number is padded to eight characters for you, and prefixed numbers such as SC or NI are handled.", "items": { "type": "string" } }, "include": { "title": "Extra data sets", "type": "array", "description": "Which premium data sets to attach to each company. Each one is a separate charged call on your provider plan, so pick only what you need. Everything at once is the fastest route but also the most expensive per company.", "items": { "type": "string", "enum": [ "profile", "financials", "officers", "psc", "shareholders", "creditChecks", "groupStructures", "filingHistory", "comprehensive" ], "enumTitles": [ "Company profile", "Filed financials", "Officers", "People with significant control", "Shareholders", "Credit checks", "Group structure", "Filing history", "Everything at once" ] }, "default": [ "profile" ] }, "subItemsPerPage": { "title": "Rows per data set", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many rows to pull for the paged data sets such as officers and filing history. Higher values return more history per company." }, "sandbox": { "title": "Sandbox mode", "type": "boolean", "description": "Call the provider's sandbox instead of live data. Responses come back in the same shape with sample values and do not spend your credits. Use this to test a run before paying for it.", "default": false }, "skipUnmatched": { "title": "Skip companies that cannot be resolved", "type": "boolean", "description": "Drop a company number the provider does not recognise instead of returning a row marked as unmatched. Unmatched rows are never charged either way.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many company records (1 to 10,000). You are charged per result returned." }, "pageSize": { "title": "Results per request", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many companies to request per search call (1 to 100). Only applies when searching rather than looking up company numbers." }, "apiKey": { "title": "Application key", "type": "string", "description": "Your own application key for the data provider. Required. Stored securely and never logged." }, "appId": { "title": "Application id", "type": "string", "description": "Your own application id for the data provider. Required, and shown next to the key in the provider's API dashboard." } } }, "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 } } } } } } } } } }