{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Company Data: Profiles, Filings, Charges and Insolvency",
    "description": "Get UK company profiles, status, SIC codes, registered office, accounts and confirmation dates, filing history, charges and insolvency from the official Companies House API with your own free key. Search by name or number. Pay per company; failures are free. Not affiliated with Companies House.",
    "version": "0.1",
    "x-build-id": "vWID5mr8hZFmhtttf"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tan-solutions~uk-companies/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tan-solutions-uk-companies",
        "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/tan-solutions~uk-companies/runs": {
      "post": {
        "operationId": "runs-sync-tan-solutions-uk-companies",
        "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/tan-solutions~uk-companies/run-sync": {
      "post": {
        "operationId": "run-sync-tan-solutions-uk-companies",
        "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": {
          "apiKey": {
            "title": "Companies House API key",
            "type": "string",
            "description": "Your own REST API key from the Companies House Developer Hub (free, about 2 minutes: see the README). Do not restrict the key to IP addresses: Apify runs use changing IPs."
          },
          "companyNumbers": {
            "title": "Company numbers",
            "type": "array",
            "description": "UK company numbers, for example 00445790, SC005336 or OC301540. Short numbers are padded to 8 digits. Duplicates are removed.",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Company names to search",
            "type": "array",
            "description": "Company names. Each search returns the best matching companies (see Results per search). Only companies are searched, never people.",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerSearch": {
            "title": "Results per search",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many matching companies each name search returns.",
            "default": 5
          },
          "matchMode": {
            "title": "Name match",
            "enum": [
              "strict",
              "all"
            ],
            "type": "string",
            "description": "Strict (default): keep a search result only when every word you typed is in the company name. Case and punctuation do not matter, and you never need to type LTD, LIMITED, PLC, LLP, THE or AND. Results that are dropped are not fetched and not charged. All: keep every company the register's search returns, including loose matches. Company numbers are never filtered.",
            "default": "strict"
          },
          "maxCompanies": {
            "title": "Max companies per run",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Hard stop for the whole run (numbers plus search results). Companies over the limit are skipped and not charged.",
            "default": 500
          },
          "includeFilingHistory": {
            "title": "Filing history",
            "type": "boolean",
            "description": "Add the most recent filings (date, category, type, description, pages).",
            "default": true
          },
          "maxFilingsPerCompany": {
            "title": "Filings per company",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many of the most recent filings to return per company.",
            "default": 25
          },
          "includeCharges": {
            "title": "Charges (mortgages)",
            "type": "boolean",
            "description": "Add registered charges for companies that have any.",
            "default": true
          },
          "includeInsolvency": {
            "title": "Insolvency cases",
            "type": "boolean",
            "description": "Add insolvency cases for companies with an insolvency history.",
            "default": true
          },
          "includeOfficers": {
            "title": "Officers (opt-in)",
            "type": "boolean",
            "description": "Add directors and secretaries, only for the company numbers you listed (never for name-search results): name, role, appointment and resignation dates, nationality, country of residence. Birth date and address are dropped. You are the controller of this personal data.",
            "default": false
          },
          "includePscs": {
            "title": "People with significant control (opt-in)",
            "type": "boolean",
            "description": "Add PSCs, only for the company numbers you listed: name, kind, nature of control, notified and ceased dates, nationality, country of residence. Birth date and address are dropped. You are the controller of this personal data.",
            "default": false
          },
          "includeBirthMonthYear": {
            "title": "Birth month and year (second opt-in)",
            "type": "boolean",
            "description": "Only with officers or PSCs on: add the month and year of birth the register shows. The day is never returned.",
            "default": false
          },
          "maxPeoplePerCompany": {
            "title": "Officers or PSCs per company",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many officers and how many PSCs to return per company when they are turned on.",
            "default": 35
          },
          "requestsPerSecond": {
            "title": "Requests per second",
            "minimum": 0.2,
            "maximum": 2,
            "type": "number",
            "description": "Companies House allows 600 requests per 5 minutes per key (2 per second). Lower it if you use the same key elsewhere at the same time.",
            "default": 2
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}