{
  "openapi": "3.0.1",
  "info": {
    "title": "Companies House API: UK Company Data & Financials",
    "description": "Companies House API data on UK companies. Look up by number or name, or find new companies by SIC code, location and incorporation date: status, address, owners and accounts figures (net assets, cash, employees; turnover and profit when filed). Pay per company found, plus per company with figures.",
    "version": "0.1",
    "x-build-id": "2A02CBAI2VwL4MCLh"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/datatools_studio~uk-company-data/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-datatools_studio-uk-company-data",
        "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/datatools_studio~uk-company-data/runs": {
      "post": {
        "operationId": "runs-sync-datatools_studio-uk-company-data",
        "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/datatools_studio~uk-company-data/run-sync": {
      "post": {
        "operationId": "run-sync-datatools_studio-uk-company-data",
        "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": "Companies",
            "type": "array",
            "description": "UK company numbers (for example <code>00445790</code> or <code>SC123456</code>), exact company names, or Companies House links, one per line. Leading zeros may be left out. Up to 50,000 per run; duplicates are skipped. Leave empty to use only <b>Find companies</b> below.",
            "items": {
              "type": "string"
            }
          },
          "nameMatching": {
            "title": "Matching company names",
            "enum": [
              "exact",
              "best"
            ],
            "type": "string",
            "description": "For lines with a company name. <b>Exact name</b> uses the company whose registered name matches (ignoring case, punctuation and \"Limited\" versus \"Ltd\"); if none does, the row is not found and lists the closest names, and is not charged. <b>Best guess</b> uses the first search result when no name matches. A company number is always exact.",
            "default": "exact"
          },
          "includeFinancials": {
            "title": "Read key figures from the latest accounts",
            "type": "boolean",
            "description": "Read turnover, profit, assets, cash, creditors, net assets and employees from the company's latest accounts, with the year before for comparison. Works when the accounts were filed digitally (inline XBRL), as most small and medium companies do; accounts filed on paper, as many large companies still do, have no readable figures. Small companies often leave turnover and profit out of the accounts they file. Companies with figures are charged an extra accounts-figures event.",
            "default": true
          },
          "includeOwners": {
            "title": "List company owners",
            "type": "boolean",
            "description": "Read the register of persons with significant control. Owners that are companies or other legal entities are listed with their share and voting bands; people are only counted, never named.",
            "default": true
          },
          "searchCompanyName": {
            "title": "Name contains",
            "type": "string",
            "description": "Find companies whose registered name contains these words, for example <code>coffee roasters</code>."
          },
          "searchSicCodes": {
            "title": "SIC codes (industry)",
            "type": "array",
            "description": "Five-digit UK SIC 2007 codes, for example <code>62012</code> (software development) or <code>56101</code> (licensed restaurants). Companies with any of the codes are found.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "searchLocation": {
            "title": "Location",
            "type": "string",
            "description": "Town, city or postcode of the registered office address, for example <code>Bristol</code> or <code>BS1</code>. Companies House matches it anywhere in the address, so <code>Bristol</code> also finds companies on a Bristol Road in other towns."
          },
          "searchIncorporatedFrom": {
            "title": "Incorporated on or after",
            "type": "string",
            "description": "A date (YYYY-MM-DD), or a time before the run such as <code>7 days</code> or <code>3 months</code>, so a scheduled run always finds the newest companies."
          },
          "searchIncorporatedTo": {
            "title": "Incorporated on or before",
            "type": "string",
            "description": "A date (YYYY-MM-DD), or a time before the run such as <code>1 day</code>."
          },
          "searchCompanyStatus": {
            "title": "Company status",
            "type": "array",
            "description": "Only companies with one of these statuses. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "dissolved",
                "liquidation",
                "receivership",
                "administration",
                "voluntary-arrangement",
                "insolvency-proceedings",
                "converted-closed",
                "open",
                "closed",
                "registered",
                "removed"
              ],
              "enumTitles": [
                "Active",
                "Dissolved",
                "Liquidation",
                "Receiver action",
                "In administration",
                "Voluntary arrangement",
                "Insolvency proceedings",
                "Converted / closed",
                "Open",
                "Closed",
                "Registered",
                "Removed"
              ]
            },
            "default": [
              "active"
            ]
          },
          "searchCompanyType": {
            "title": "Company type",
            "type": "array",
            "description": "Only companies of these types. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "ltd",
                "plc",
                "llp",
                "private-unlimited",
                "private-limited-guarant-nsc",
                "private-limited-guarant-nsc-limited-exemption",
                "private-limited-shares-section-30-exemption",
                "limited-partnership",
                "scottish-partnership",
                "charitable-incorporated-organisation",
                "scottish-charitable-incorporated-organisation",
                "registered-society-non-jurisdictional",
                "uk-establishment",
                "oversea-company",
                "registered-overseas-entity"
              ],
              "enumTitles": [
                "Private limited company",
                "Public limited company",
                "Limited liability partnership",
                "Private unlimited company",
                "Private limited by guarantee",
                "Private limited by guarantee, 'Limited' exemption",
                "Private limited by shares, 'Limited' exemption",
                "Limited partnership",
                "Scottish qualifying partnership",
                "Charitable incorporated organisation",
                "Scottish charitable incorporated organisation",
                "Registered society",
                "UK establishment of an overseas company",
                "Overseas company",
                "Overseas entity"
              ]
            },
            "default": []
          },
          "maxSearchResults": {
            "title": "Maximum companies found",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "The most companies one search adds to the run. When more companies match, the newest (by incorporation date) are kept. The total number of matches is in the run summary.",
            "default": 100
          },
          "searchResultsOnly": {
            "title": "List search results only (faster)",
            "type": "boolean",
            "description": "Write the details the search itself returns (name, number, status, type, incorporation date, SIC codes, address) without opening each company. Much faster for long lists: one request returns up to 5,000 companies, instead of about four requests per company. Accounts figures and owners are left out. Each company listed this way is charged the smaller company-listed fee instead of company-record.",
            "default": false
          },
          "monitorChanges": {
            "title": "Report changes since the last run",
            "type": "boolean",
            "description": "Remember key facts of each company in a named key-value store in your own account (status, name, address, accounts dates and figures, company owners) and report what changed since your previous run. Use it with a schedule.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Storage name for change tracking",
            "type": "string",
            "description": "Name of the key-value store (in your account) that keeps each company's last known facts. Use different names to keep separate watch lists. The Actor creates this storage on the first run and can only use storages it created itself.",
            "default": "uk-company-data-monitor"
          },
          "companiesHouseApiKey": {
            "title": "Your Companies House API key (optional)",
            "type": "string",
            "description": "Leave empty to use the built-in key, which all users share (about 100 requests a minute in total). With your own free key, your runs get the full Companies House limit to themselves: register at developer.company-information.service.gov.uk, create a live application, create a new key of the type \"API key\" and paste it here. It is stored encrypted."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}