{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Companies House Scraper: Company Lists | $1/1K",
    "description": "UK companies from the Companies House free monthly file: company number, name, status, type, address, SIC codes, accounts dates, charges. Filter by SIC, postcode, town, age and name. $1 per 1,000 results, platform usage included.",
    "version": "0.1",
    "x-build-id": "ZQQaozhKmignhe8tE"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/one_dollar_store~uk-company-register-bulk-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-one_dollar_store-uk-company-register-bulk-scraper",
        "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/one_dollar_store~uk-company-register-bulk-scraper/runs": {
      "post": {
        "operationId": "runs-sync-one_dollar_store-uk-company-register-bulk-scraper",
        "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/one_dollar_store~uk-company-register-bulk-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-one_dollar_store-uk-company-register-bulk-scraper",
        "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",
            "maxItems": 200,
            "type": "array",
            "description": "Keep companies with one of these SIC 2007 codes. Use a full five digit code such as 62012 (business software development) or a shorter start such as 62 (all computer programming and consultancy) or 6201. The file lists up to four codes per company; by default any of them can match. Leave empty for every industry.",
            "items": {
              "type": "string"
            }
          },
          "sicMatch": {
            "title": "Match SIC code on",
            "enum": [
              "any",
              "primary"
            ],
            "type": "string",
            "description": "Look at all SIC codes of a company, or only its first (main) one.",
            "default": "any"
          },
          "postcodes": {
            "title": "Postcode areas or districts",
            "maxItems": 200,
            "type": "array",
            "description": "Keep companies whose registered office postcode is in one of these areas or districts, for example EC, M, SW (areas) or EC1V, SW1A, B33 (districts). A district such as SW1 also covers SW1A but not SW10.",
            "items": {
              "type": "string"
            }
          },
          "towns": {
            "title": "Towns",
            "maxItems": 200,
            "type": "array",
            "description": "Keep companies whose registered office post town is one of these, for example Leeds or Cardiff. Capital letters do not matter. The town must be spelled as the register spells it.",
            "items": {
              "type": "string"
            }
          },
          "counties": {
            "title": "Counties",
            "maxItems": 200,
            "type": "array",
            "description": "Keep companies whose registered office county is one of these, for example Hertfordshire. Many addresses have no county, so postcodes or towns are more reliable.",
            "items": {
              "type": "string"
            }
          },
          "statuses": {
            "title": "Company status",
            "type": "array",
            "description": "Keep companies with one of these statuses. The default is Active. The file lists live companies only, so dissolved companies are never included. Clear the list for every status.",
            "items": {
              "type": "string",
              "enum": [
                "Active",
                "Active - Proposal to Strike off",
                "Liquidation",
                "In Administration",
                "Voluntary Arrangement",
                "In Administration/Administrative Receiver",
                "In Administration/Receiver Manager",
                "Live but Receiver Manager on at least one charge",
                "RECEIVERSHIP",
                "ADMINISTRATION ORDER",
                "ADMINISTRATIVE RECEIVER",
                "RECEIVER MANAGER / ADMINISTRATIVE RECEIVER",
                "VOLUNTARY ARRANGEMENT / RECEIVER MANAGER",
                "VOLUNTARY ARRANGEMENT / ADMINISTRATIVE RECEIVER"
              ],
              "enumTitles": [
                "Active",
                "Active, proposal to strike off",
                "In liquidation",
                "In administration",
                "Voluntary arrangement",
                "In administration, administrative receiver",
                "In administration, receiver manager",
                "Receiver manager on a charge",
                "Receivership",
                "Administration order",
                "Administrative receiver",
                "Receiver manager or administrative receiver",
                "Voluntary arrangement, receiver manager",
                "Voluntary arrangement, administrative receiver"
              ]
            },
            "default": [
              "Active"
            ]
          },
          "companyTypes": {
            "title": "Company types",
            "type": "array",
            "description": "Keep companies of these types. Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "Private Limited Company",
                "PRI/LTD BY GUAR/NSC (Private, limited by guarantee, no share capital)",
                "Limited Partnership",
                "Limited Liability Partnership",
                "Community Interest Company",
                "Charitable Incorporated Organisation",
                "PRI/LBG/NSC (Private, Limited by guarantee, no share capital, use of 'Limited' exemption)",
                "Overseas Entity",
                "Other company type",
                "Registered Society",
                "Scottish Charitable Incorporated Organisation",
                "Private Unlimited Company",
                "Public Limited Company",
                "Royal Charter Company",
                "Investment Company with Variable Capital",
                "United Kingdom Economic Interest Grouping",
                "Scottish Partnership",
                "Industrial and Provident Society",
                "Private Unlimited",
                "Investment Company with Variable Capital(Umbrella)",
                "Old Public Company",
                "PRIV LTD SECT. 30 (Private limited company, section 30 of the Companies Act)",
                "Investment Company with Variable Capital (Securities)",
                "United Kingdom Societas",
                "Protected Cell Company",
                "Other Company Type",
                "Further Education and Sixth Form College Corps",
                "Converted/Closed"
              ],
              "enumTitles": [
                "Private Limited Company",
                "PRI/LTD BY GUAR/NSC (Private, limited by guarantee, no share capital)",
                "Limited Partnership",
                "Limited Liability Partnership",
                "Community Interest Company",
                "Charitable Incorporated Organisation",
                "PRI/LBG/NSC (Private, Limited by guarantee, no share capital, use of 'Limited' exemption)",
                "Overseas Entity",
                "Other company type",
                "Registered Society",
                "Scottish Charitable Incorporated Organisation",
                "Private Unlimited Company",
                "Public Limited Company",
                "Royal Charter Company",
                "Investment Company with Variable Capital",
                "United Kingdom Economic Interest Grouping",
                "Scottish Partnership",
                "Industrial and Provident Society",
                "Private Unlimited",
                "Investment Company with Variable Capital(Umbrella)",
                "Old Public Company",
                "PRIV LTD SECT. 30 (Private limited company, section 30 of the Companies Act)",
                "Investment Company with Variable Capital (Securities)",
                "United Kingdom Societas",
                "Protected Cell Company",
                "Other Company Type",
                "Further Education and Sixth Form College Corps",
                "Converted/Closed"
              ]
            }
          },
          "incorporatedFrom": {
            "title": "Incorporated from",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "Keep companies incorporated on or after this date (YYYY-MM-DD)."
          },
          "incorporatedTo": {
            "title": "Incorporated until",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "Keep companies incorporated on or before this date (YYYY-MM-DD)."
          },
          "incorporatedWithinDays": {
            "title": "Incorporated in the last (days)",
            "minimum": 1,
            "maximum": 36500,
            "type": "integer",
            "description": "Keep companies incorporated in the last N days before the run, for new company lead lists. The file is a monthly snapshot, so the newest companies are those up to the file date."
          },
          "nameContains": {
            "title": "Name contains",
            "maxItems": 50,
            "type": "array",
            "description": "Keep companies whose name contains any of these words or phrases. Capital letters do not matter. Searching a very common word such as limited returns most of the register.",
            "items": {
              "type": "string"
            }
          },
          "nameExcludes": {
            "title": "Name does not contain",
            "maxItems": 50,
            "type": "array",
            "description": "Drop companies whose name contains any of these words or phrases.",
            "items": {
              "type": "string"
            }
          },
          "accountsCategories": {
            "title": "Accounts category",
            "type": "array",
            "description": "Keep companies whose last accounts are of these types, for example MICRO ENTITY or DORMANT. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "MICRO ENTITY",
                "NO ACCOUNTS FILED",
                "TOTAL EXEMPTION FULL",
                "DORMANT",
                "UNAUDITED ABRIDGED",
                "FULL",
                "SMALL",
                "AUDIT EXEMPTION SUBSIDIARY",
                "GROUP",
                "TOTAL EXEMPTION SMALL",
                "MEDIUM",
                "ACCOUNTS TYPE NOT AVAILABLE",
                "AUDITED ABRIDGED",
                "FILING EXEMPTION SUBSIDIARY",
                "PARTIAL EXEMPTION",
                "INITIAL"
              ],
              "enumTitles": [
                "MICRO ENTITY",
                "NO ACCOUNTS FILED",
                "TOTAL EXEMPTION FULL",
                "DORMANT",
                "UNAUDITED ABRIDGED",
                "FULL",
                "SMALL",
                "AUDIT EXEMPTION SUBSIDIARY",
                "GROUP",
                "TOTAL EXEMPTION SMALL",
                "MEDIUM",
                "ACCOUNTS TYPE NOT AVAILABLE",
                "AUDITED ABRIDGED",
                "FILING EXEMPTION SUBSIDIARY",
                "PARTIAL EXEMPTION",
                "INITIAL"
              ]
            }
          },
          "accountsOverdue": {
            "title": "Accounts overdue",
            "enum": [
              "any",
              "yes",
              "no"
            ],
            "type": "string",
            "description": "Keep only active companies whose next accounts due date is before the file date, or only those that are not. Companies may have filed since the file was made.",
            "default": "any"
          },
          "outstandingCharges": {
            "title": "Outstanding charges",
            "enum": [
              "any",
              "yes",
              "no"
            ],
            "type": "string",
            "description": "Keep only companies with a charge (mortgage) still outstanding, or only those without.",
            "default": "any"
          },
          "maxItems": {
            "title": "Maximum results",
            "minimum": 10,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many companies (minimum 10, maximum 100,000). The file is read in alphabetical order of company name, and the run ends as soon as this many are found. A narrow filter can need the whole file, which takes a few minutes.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}