{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Companies House — Directors, Owners (PSC) & Filings",
    "description": "UK company profiles, directors, persons with significant control (owners) and filing history from the official Companies House API. Look up by number, name or advanced search (SIC code, location, status, incorporation date). Uses your own free API key. Pay per record.",
    "version": "1.0",
    "x-build-id": "D2FPOmmMcLhR08Pdw"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/powerfully_goliath~uk-company-officers/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-powerfully_goliath-uk-company-officers",
        "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/powerfully_goliath~uk-company-officers/runs": {
      "post": {
        "operationId": "runs-sync-powerfully_goliath-uk-company-officers",
        "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/powerfully_goliath~uk-company-officers/run-sync": {
      "post": {
        "operationId": "run-sync-powerfully_goliath-uk-company-officers",
        "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 free REST API key from https://developer.company-information.service.gov.uk/ (register, create an application, add a REST key). Stored encrypted; never logged or written to the output."
          },
          "companyNumbers": {
            "title": "Company numbers",
            "type": "array",
            "description": "8-character Companies House numbers, e.g. 00612172, SC123456, OC301234. Leading zeros may be left off.",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Company name searches",
            "type": "array",
            "description": "Company names to look up; each takes the top match(es) from Companies House search.",
            "items": {
              "type": "string"
            }
          },
          "searchResultsPerQuery": {
            "title": "Matches per name search",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many search matches to take for each name (1 = best match only).",
            "default": 1
          },
          "nameIncludes": {
            "title": "Name includes",
            "type": "string",
            "description": "Advanced search: company names containing this text."
          },
          "sicCodes": {
            "title": "SIC codes",
            "type": "array",
            "description": "Advanced search: nature-of-business codes, e.g. 56101 (restaurants), 62012 (software), 41202 (house building).",
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Advanced search: registered office location, e.g. 'Leeds' or 'LS1'."
          },
          "companyStatuses": {
            "title": "Company status",
            "type": "array",
            "description": "Advanced search: e.g. active only.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "dissolved",
                "liquidation",
                "receivership",
                "administration",
                "voluntary-arrangement",
                "converted-closed",
                "insolvency-proceedings",
                "registered",
                "removed",
                "closed",
                "open"
              ],
              "enumTitles": [
                "Active",
                "Dissolved",
                "Liquidation",
                "Receivership",
                "Administration",
                "Voluntary arrangement",
                "Converted closed",
                "Insolvency proceedings",
                "Registered",
                "Removed",
                "Closed",
                "Open"
              ]
            }
          },
          "incorporatedFrom": {
            "title": "Incorporated on or after",
            "type": "string",
            "description": "Advanced search: e.g. '30 days' for new companies."
          },
          "incorporatedTo": {
            "title": "Incorporated on or before",
            "type": "string",
            "description": "Advanced search: latest incorporation date."
          },
          "includeCompanyProfile": {
            "title": "Company profile",
            "type": "boolean",
            "description": "One 'company' row per company: status, type, dates, registered office, SIC codes, accounts and confirmation-statement dates.",
            "default": true
          },
          "includeOfficers": {
            "title": "Officers (directors, secretaries)",
            "type": "boolean",
            "description": "One 'officer' row per current officer.",
            "default": true
          },
          "includeResignedOfficers": {
            "title": "Include resigned officers",
            "type": "boolean",
            "description": "Also return officers who have resigned.",
            "default": false
          },
          "includePscs": {
            "title": "Persons with significant control (owners)",
            "type": "boolean",
            "description": "One 'psc' row per current person or entity with significant control.",
            "default": true
          },
          "includeCeasedPscs": {
            "title": "Include ceased PSCs",
            "type": "boolean",
            "description": "Also return PSCs that have ceased.",
            "default": false
          },
          "includeFilings": {
            "title": "Filing history",
            "type": "boolean",
            "description": "One 'filing' row per filing (newest first) with a link to the document.",
            "default": false
          },
          "filingCategories": {
            "title": "Filing categories",
            "type": "array",
            "description": "Only these filing categories. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "accounts",
                "address",
                "annual-return",
                "capital",
                "change-of-name",
                "confirmation-statement",
                "incorporation",
                "liquidation",
                "miscellaneous",
                "mortgage",
                "officers",
                "resolution",
                "persons-with-significant-control",
                "insolvency",
                "gazette"
              ],
              "enumTitles": [
                "Accounts",
                "Address",
                "Annual return",
                "Capital",
                "Change of name",
                "Confirmation statement",
                "Incorporation",
                "Liquidation",
                "Miscellaneous",
                "Mortgage",
                "Officers",
                "Resolution",
                "Persons with significant control",
                "Insolvency",
                "Gazette"
              ]
            }
          },
          "maxFilingsPerCompany": {
            "title": "Max filings per company",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Newest filings first.",
            "default": 25
          },
          "maxItems": {
            "title": "Maximum rows",
            "minimum": 1,
            "maximum": 200000,
            "type": "integer",
            "description": "Stop after this many rows of any type. You are charged only for rows delivered.",
            "default": 100
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}