{
  "openapi": "3.0.1",
  "info": {
    "title": "Companies House API: Export UK Company Lists by SIC Code",
    "description": "Companies House data without an API key: export UK company lists by SIC code, postcode area or district, status, company type, accounts category and incorporation date, or get a monthly feed of new companies. Company-level data from the free monthly snapshot: no directors, no PSCs, no care-of names.",
    "version": "0.1",
    "x-build-id": "y37TsSECJEUBvG5BX"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/quarrywise~companies-house-api-company-export/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-quarrywise-companies-house-api-company-export",
        "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/quarrywise~companies-house-api-company-export/runs": {
      "post": {
        "operationId": "runs-sync-quarrywise-companies-house-api-company-export",
        "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/quarrywise~companies-house-api-company-export/run-sync": {
      "post": {
        "operationId": "run-sync-quarrywise-companies-house-api-company-export",
        "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": {
          "sicCodes": {
            "title": "SIC codes (activity)",
            "type": "array",
            "description": "UK SIC 2007 codes of the company's activities, for example 62012 (business and domestic software development) or 70229 (management consultancy). Five digits match that code; two to four digits match every five-digit code that starts with them, so 62 covers 62011 to 62090. An older four-digit SIC 2003 code that some companies still carry (for example 6210) matches only when given exactly. A company matches when any of its up to four SIC codes matches. \"62012 - Business and domestic software development\" and \"62.01/2\" are read as 62012. One run covers at most 30 SIC codes after expanding prefixes (62 is 5 codes, 47 is 44): split wider searches into several runs or add postcodes.",
            "items": {
              "type": "string"
            }
          },
          "postcodes": {
            "title": "Postcode areas or districts (registered office)",
            "type": "array",
            "description": "Postcode areas (the letters, for example M for Manchester, EC for the City of London) or districts (the part before the space, for example M1, EC1A, SW1A). A full postcode is not accepted. Leave empty for the whole UK when you give SIC codes. One run covers at most 30 postcode areas (and at most 30 SIC codes after expanding prefixes); combine SIC codes with postcodes to narrow a wide search.",
            "items": {
              "type": "string"
            }
          },
          "companyStatus": {
            "title": "Company status",
            "uniqueItems": true,
            "type": "array",
            "description": "Statuses on the register. Default: active companies only. The snapshot holds live companies only, so dissolved companies are never in it. Choose \"Any status\" to include every live status.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "proposal-to-strike-off",
                "liquidation",
                "administration",
                "voluntary-arrangement",
                "receivership",
                "other",
                "any"
              ],
              "enumTitles": [
                "Active",
                "Active, proposal to strike off",
                "In liquidation",
                "In administration",
                "Voluntary arrangement",
                "Receivership",
                "Other live statuses",
                "Any status"
              ]
            },
            "default": [
              "active"
            ]
          },
          "companyTypes": {
            "title": "Company types",
            "uniqueItems": true,
            "type": "array",
            "description": "Company categories on the register, grouped. Leave empty for every type. Rows of partnerships other than LLPs carry is_partnership: true (their partners can be private individuals).",
            "items": {
              "type": "string",
              "enum": [
                "private-limited",
                "public-limited",
                "limited-by-guarantee",
                "llp",
                "limited-partnership",
                "other-partnership",
                "community-interest-company",
                "charitable-incorporated-organisation",
                "unlimited",
                "registered-society",
                "overseas",
                "other"
              ],
              "enumTitles": [
                "Private limited company",
                "Public limited company (PLC)",
                "Private company limited by guarantee",
                "Limited liability partnership (LLP)",
                "Limited partnership",
                "Other partnership (for example Scottish partnership)",
                "Community interest company (CIC)",
                "Charitable incorporated organisation (CIO)",
                "Unlimited company",
                "Registered society",
                "Overseas company or UK establishment",
                "Other company types"
              ]
            }
          },
          "accountsCategories": {
            "title": "Accounts category (size proxy)",
            "uniqueItems": true,
            "type": "array",
            "description": "The category of the company's last accounts, a rough size signal: micro-entity and total exemption for the smallest companies, small, medium, full and group for larger ones, dormant for companies that do not trade. Leave empty for any.",
            "items": {
              "type": "string",
              "enumSuggestedValues": [
                "micro-entity",
                "small",
                "medium",
                "full",
                "group",
                "dormant",
                "total-exemption-full",
                "total-exemption-small",
                "unaudited-abridged",
                "audited-abridged",
                "audit-exemption-subsidiary",
                "filing-exemption-subsidiary",
                "partial-exemption",
                "initial",
                "no-accounts-filed",
                "accounts-type-not-available"
              ],
              "enumTitles": [
                "Micro-entity",
                "Small",
                "Medium",
                "Full",
                "Group",
                "Dormant",
                "Total exemption full",
                "Total exemption small",
                "Unaudited abridged",
                "Audited abridged",
                "Audit exemption subsidiary",
                "Filing exemption subsidiary",
                "Partial exemption",
                "Initial",
                "No accounts filed",
                "Accounts type not available"
              ]
            }
          },
          "incorporatedFrom": {
            "title": "Incorporated on or after",
            "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "Only companies incorporated on or after this date: a date (YYYY-MM-DD) or a period back from today such as \"30 days\" or \"6 months\". Chunks of older companies are skipped, so this also makes runs faster."
          },
          "incorporatedTo": {
            "title": "Incorporated on or before",
            "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "Only companies incorporated on or before this date (YYYY-MM-DD, or a period back from today such as \"1 year\")."
          },
          "overdue": {
            "title": "Overdue filings",
            "enum": [
              "any",
              "accounts",
              "confirmationStatement",
              "either"
            ],
            "type": "string",
            "description": "Only companies whose accounts or confirmation statement were already due on the snapshot date (next due date before the snapshot). Default: no filter.",
            "default": "any"
          },
          "mode": {
            "title": "Mode",
            "enum": [
              "export",
              "newSinceLastRun"
            ],
            "type": "string",
            "description": "Export: every company that matches the filters, newest incorporation first, up to the maximum. New-company feed: only companies that were not in the previous run with the same watch ID. The data changes once a month, so schedule the feed monthly (for example on the 8th); a run on an unchanged snapshot outputs nothing and is not charged the feed-run event.",
            "default": "export"
          },
          "watchId": {
            "title": "Watch ID (new-company feed)",
            "pattern": "^[A-Za-z0-9._-]{1,64}$",
            "type": "string",
            "description": "Required for the new-company feed: a name for this feed, for example \"manchester-software\". Runs with the same watch ID are compared with each other. Letters, digits, \".\", \"_\" and \"-\" only, up to 64 characters."
          },
          "outputOnFirstRun": {
            "title": "Output everything on the first feed run",
            "type": "boolean",
            "description": "New-company feed only. On, the first run of a watch outputs every matching company (charged per row) and remembers them. Off, the first run only records the current companies as a baseline and outputs nothing (no rows charged; the run is still charged the feed-run event, $0.005), so later runs return new companies only.",
            "default": true
          },
          "addressDetail": {
            "title": "Registered office detail",
            "enum": [
              "districtOnly",
              "full"
            ],
            "type": "string",
            "description": "District only (default): post town and postcode district. Full: also the street lines, full postcode, county and country of the registered office. The registered office of a small company is often a director's home address, so use full detail only when you need it (for example for letters or compliance checks).",
            "default": "districtOnly"
          },
          "maxResults": {
            "title": "Maximum companies",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Stop after this many company rows (in the feed: new companies). Each saved row costs $0.0015, so this also caps the cost: the prefilled 50 rows cost $0.075, plus Apify's start event. Companies that are filtered out are free. Left out of an API call, it is 1,000 ($1.50). You can also set a maximum charge per run in the run options.",
            "default": 1000
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}